Show:

ia.BoundingBox Class

Defined in: ia\geom\BoundingBox.js:1
Module: ia

An area defined by its position, as indicated by its bottom-left corner point (xMin, yMin) and by its top-right corner point (xMax, yMax).

Constructor

ia.BoundingBox

(
  • [xMin=0]
  • [yMin=0]
  • [xMax=100]
  • [yMax=100]
)

Defined in ia\geom\BoundingBox.js:1

Parameters:

  • [xMin=0] Number optional

    The x-coord of the bottom-left corner.

  • [yMin=0] Number optional

    The y-coord of the bottom-left corner.

  • [xMax=100] Number optional

    The x-coord of the top-right corner.

  • [yMax=100] Number optional

    The y-coord of the top-right corner.

Methods

bottom

() Number

Defined in ia\geom\BoundingBox.js:44

Returns the bottom coord.

Returns:

Number: The coordinate.

clone

() ia.BoundingBox

Defined in ia\geom\BoundingBox.js:237

Gets a clone of this bounding box.

Returns:

ia.BoundingBox: The bounding box.

contains

(
  • bBox
)
Boolean

Defined in ia\geom\BoundingBox.js:280

Tests whether a bounding box is contained within this one.

Parameters:

Returns:

Boolean: true if bounding box is contained within this one, otherwise false.

equals

(
  • bBox
)
Boolean

Defined in ia\geom\BoundingBox.js:248

Tests whether a bounding box is equal to this one.

Parameters:

Returns:

Boolean: true if bounding box is equal to this one, otherwise false.

getHeight

() Number

Defined in ia\geom\BoundingBox.js:216

Returns the height of the bounding box.

Returns:

Number: The height.

getWidth

() Number

Defined in ia\geom\BoundingBox.js:132

Returns the width of the bounding box.

Returns:

Number: The width.

getXCenter

() Number

Defined in ia\geom\BoundingBox.js:111

Returns the x-coord of the center of the bounding box.

Returns:

Number: The coordinate.

getXMax

() Number

Defined in ia\geom\BoundingBox.js:90

Returns the x-coord of the right edge of the bounding box.

Returns:

Number: The coordinate.

getXMin

() Number

Defined in ia\geom\BoundingBox.js:66

Returns the x-coord of the left edge of the bounding box.

Returns:

Number: The coordinate.

getYCenter

() Number

Defined in ia\geom\BoundingBox.js:195

Returns the y-coord of the center of the bounding box.

Returns:

Number: The coordinate.

getYMax

() Number

Defined in ia\geom\BoundingBox.js:174

Returns the y-coord of the top edge of the bounding box.

Returns:

Number: The coordinate.

getYMin

() Number

Defined in ia\geom\BoundingBox.js:153

Returns the y-coord of the bottom edge of the bounding box.

Returns:

Number: The coordinate.

intersects

(
  • bBox
)
Boolean

Defined in ia\geom\BoundingBox.js:264

Tests whether a bounding box intersects this one.

Parameters:

Returns:

Boolean: true if bounding bounding boxes intercept, otherwise false.

left

() Number

Defined in ia\geom\BoundingBox.js:22

Returns the left coord.

Returns:

Number: The coordinate.

right

() Number

Defined in ia\geom\BoundingBox.js:33

Returns the right coord.

Returns:

Number: The coordinate.

setHeight

(
  • h
)

Defined in ia\geom\BoundingBox.js:224

Sets the height of the bounding box.

Parameters:

  • h Number

    The height.

setWidth

(
  • w
)

Defined in ia\geom\BoundingBox.js:140

Sets the width of the bounding box.

Parameters:

  • w Number

    The width.

setXCenter

(
  • x
)

Defined in ia\geom\BoundingBox.js:119

Sets the x-coord of the center of the bounding box.

Parameters:

  • x Number

    The coordinate.

setXMax

(
  • x
)

Defined in ia\geom\BoundingBox.js:98

Sets the x-coord of the right edge of the bounding box.

Parameters:

  • x Number

    The coordinate.

setXMin

(
  • x
)

Defined in ia\geom\BoundingBox.js:77

Sets the x-coord of the left edge of the bounding box.

Parameters:

  • x Number

    The coordinate.

setYCenter

(
  • y
)

Defined in ia\geom\BoundingBox.js:203

Sets the y-coord of the center of the bounding box.

Parameters:

  • y Number

    The coordinate.

setYMax

(
  • y
)

Defined in ia\geom\BoundingBox.js:182

Sets the y-coord of the top edge of the bounding box.

Parameters:

  • y Number

    The coordinate.

setYMin

(
  • y
)

Defined in ia\geom\BoundingBox.js:161

Sets the y-coord of the bottom edge of the bounding box.

Parameters:

  • y Number

    The coordinate.

top

() Number

Defined in ia\geom\BoundingBox.js:55

Returns the top coord.

Returns:

Number: The coordinate.

toString

() String

Defined in ia\geom\BoundingBox.js:296

Gets a simple text representation of this bounding box.

Returns:

String: A text String.